Skip to content

docs: quick-start: using an existing node key (plain or encrypted, Docker or native) - #174

Merged
EnzinoBB merged 3 commits into
masterfrom
docs/quick-start-keys
Nov 7, 2026
Merged

EnzinoBB merged 3 commits into
masterfrom
docs/quick-start-keys

Conversation

@EnzinoBB

@EnzinoBB EnzinoBB commented Nov 7, 2026

Copy link
Copy Markdown
Collaborator

Adds section 10 "Using your existing node key" to docs/quick-start.md (Troubleshooting becomes 11). It covers four cases, each with copy-paste steps:

  1. Native, plain key: put NodePrivate.txt and NodePublic.txt in csnode before setup.sh / setup.bat. The set-up offers the key as the account node and sets mode 600.
  2. Native, encrypted key: the node asks for the password on its console at every start. That works in tmux or a Windows console, not under systemd. The wallet asks for the node's password and needs about 1 GB of free memory.
  3. Docker, plain key: stop the container, save ~/.credits/keys, copy the files in with owner 1000 and mode 600, start, then check with credits-wallet account node-key. The node does not log its own public key. The container makes new keys only when keys/NodePublic.txt is missing (entrypoint.sh line 187).
  4. Docker, encrypted key: convert the key once with the image's own node --dumpkeys, then continue as in case 3. Includes a native variant, for systemd.

Warnings: never run two nodes with the same key; keep an offline backup, since a plain key is as exposed as the machine; the wallet opens a plain node key without a password, but on mainnet it still asks you to type send.

Tested

Tested with a throwaway key, never a real one, on ghcr.io/creditscommunity/credits-node:latest (4.2.532-community.17, build 34022dd):

  • I encrypted a wallet-made plain key with the image's node --encryptkey. The result decodes to 88 bytes.
  • I ran the guide's Docker blocks exactly as written, on a real TTY through pexpect, with a uid-1000 folder:
    • typing p, Enter, the password and Enter works;
    • the node prints Keys dumped to /keyconv/keys.json and exits 0;
    • the plain files decode to 64 and 32 bytes, with no newline, owner 1000, mode 600;
    • they are byte-identical to the original plain key.
  • I ran the native block exactly as written, with the package's node binary. It gives the same identical result.
  • The image's own entrypoint started with the converted keys, with no stdin. It asked nothing and generated no new keys. credits-wallet account node-key inside the running container showed the original address with public file ... matches. A clean docker stop exited 0.

Not tested: the Windows PowerShell lines.

🤖 Generated with Claude Code

EnzinoBB and others added 3 commits November 7, 2026 15:43
…cker or native)

A new section 10 for operators who keep an identity they already have: a
plain key in the native folder before the set-up, an encrypted key on a
console (not under systemd), a plain key in Docker (~/.credits/keys, uid
1000, mode 600; the container makes keys only when keys/NodePublic.txt is
missing), and an encrypted key in Docker, converted once with the image's
own node --dumpkeys. Also the native conversion for systemd. Troubleshooting
becomes section 11.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@EnzinoBB
EnzinoBB merged commit 408c539 into master Nov 7, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant